/*
 * Copyright (C) 2017-2018 Ignite Realtime Foundation. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jivesoftware.admin;

import javax.servlet.http.HttpServletRequest;

public interface ServletRequestAuthenticator {

    /**
     * Attempts to authenticate an HTTP request to a page on the admin console.
     * @param request the request to authenticate
     * @return the username if it was possible to determine from the request, otherwise {@code null}
     */
    String authenticateRequest(final HttpServletRequest request);

}
